Xbasic

SQL::ConnectionListPortableSQLFunctions Method

Syntax

List as C = ListPortableSQLFunctions(Syntax as C = "")

Arguments

SyntaxCharacter

The name of a syntax. See listSyntaxes() for a list of allowed values.

Returns

ListCharacter

A list of functions in the format: Name Prototype Description

Description

Returns a list of supported Portable SQL functions for the connection Syntax.

Discussion

Create a crlf() delimited list of portable SQL functions.

Within each row, the tab delimited columns are: Name, Prototype, Description, Aggregate=Y/N, Summary=Y/N, Category

If you provide a syntax name, only functions supported by that syntax will be included.

If you do not provide a syntax name, all functions will be included.

Geography functions are only supported for some databases.

The ListPortableSQLFunctions() method returns a list of functions that are mapped by syntax handlers to the target database, or are considered portable (can be used in generic queries).

Example

dim conn as SQL::Connection
dim connString as C
connString = "{A5API='Access', FileName='c:\program files\a5v8\mdbfiles\alphasports.mdb'}"
if .not. conn.open(connString)
    ui_msg_box("Error", conn.CallResult.text)
    end
end if
ui_msg_box("Portable SQL Functions", conn.ListPortableSQLFunctions())
conn.close()

See Also